home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / UNINDEX.PY < prev    next >
Encoding:
Python Source  |  2000-11-13  |  11.0 KB  |  339 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85.  
  86. """Simple column indices"""
  87. __version__='$Revision: 1.11.2.4 $'[11:-2]
  88.  
  89. from Globals import Persistent
  90. from Acquisition import Implicit
  91. import BTree
  92. import IOBTree
  93. from intSet import intSet
  94. import operator
  95. from Missing import MV
  96. import string, pdb
  97. from zLOG import LOG, ERROR
  98.  
  99. ListType=type([])
  100. StringType=type('s')
  101.  
  102.  
  103. def nonEmpty(s):
  104.     "returns true if a non-empty string or any other (nonstring) type"
  105.     if type(s) is StringType:
  106.         if s: return 1
  107.         else: return 0
  108.     else:
  109.         return 1
  110.  
  111.  
  112. class UnIndex(Persistent, Implicit):
  113.     """UnIndex object interface"""
  114.  
  115.     meta_type = 'Field Index'
  116.  
  117.     def __init__(self, id=None, ignore_ex=None, call_methods=None):
  118.         """Create an unindex
  119.  
  120.         UnIndexes are indexes that contain two index components, the
  121.         forward index (like plain index objects) and an inverted
  122.         index.  The inverted index is so that objects can be unindexed 
  123.         even when the old value of the object is not known.
  124.  
  125.         The arguments are:
  126.  
  127.           'id' -- the name of the item attribute to index.  This is
  128.           either an attribute name or a record key.
  129.  
  130.           'ignore_ex' -- should be set to true if you want the index
  131.           to ignore exceptions raised while indexing instead of
  132.           propagating them.
  133.  
  134.           'call_methods' -- should be set to true if you want the index 
  135.           to call the attribute 'id' (note: 'id' should be callable!)
  136.           You will also need to pass in an object in the index and
  137.           uninded methods for this to work.
  138.  
  139.         """
  140.     ######################################################################
  141.     # For b/w compatability, have to allow __init__ calls with zero args
  142.  
  143.         if not id==ignore_ex==call_methods==None:
  144.             self.id = id
  145.             self.ignore_ex=ignore_ex        # currently unimplimented
  146.             self.call_methods=call_methods
  147.             self._index = BTree.BTree()
  148.             self._unindex = IOBTree.BTree()
  149.  
  150.         else:
  151.             pass
  152.  
  153.  
  154.     def __len__(self):
  155.         return len(self._unindex)
  156.  
  157.     def index_object(self, i, obj, threshold=None):
  158.         """ index and object 'obj' with integer id 'i'"""
  159.  
  160.         # Before we do anything, unindex the object we've been handed, as
  161.         # we can't depend on the user to do the right thing.
  162.         self.unindex_object(i)
  163.         
  164.         index = self._index
  165.         unindex = self._unindex
  166.  
  167.         id = self.id
  168.  
  169.         try:
  170.             k=getattr(obj, id)
  171.             if callable(k):
  172.                 k = k()
  173.         except:
  174.             k = MV
  175.  
  176. ##        if k is None or k == MV:
  177. ##            return 0
  178.  
  179.         set = index.get(k)
  180.         if set is None:
  181.             index[k] = set = intSet()
  182.             
  183.         set.insert(i)
  184.         unindex[i] = k
  185.  
  186.  
  187.         self._index = index
  188.         self._unindex = unindex
  189.  
  190.         return 1
  191.     
  192.  
  193.     def unindex_object(self, i):
  194.         """ Unindex the object with integer id 'i' and don't
  195.         raise an exception if we fail """
  196.         index = self._index
  197.         unindex = self._unindex
  198.  
  199.         k = unindex.get(i, None)
  200.         if k is None:
  201.             return None
  202.         set = index.get(k, None)
  203.         if set is not None:
  204.             try:
  205.                 set.remove(i)
  206.             except:
  207.                 LOG('UnIndex', ERROR, ('unindex_object could not remove '
  208.                                        'integer id %s from index %s.  This '
  209.                                        'should not happen.'
  210.                                        % (str(i), str(k)))) 
  211.         else:
  212.             LOG('UnIndex', ERROR, ('unindex_object tried to retrieve set %s '
  213.                                    'from index %s but couldn\'t.  This '
  214.                                    'should not happen.' % (repr(set),str(k))))
  215.  
  216.         del unindex[i]
  217.         
  218.         self._index = index
  219.         self._unindex = unindex
  220.  
  221.  
  222.     def _apply_index(self, request, cid=''): 
  223.         """Apply the index to query parameters given in the argument,
  224.         request
  225.  
  226.         The argument should be a mapping object.
  227.  
  228.         If the request does not contain the needed parameters, then
  229.         None is returned.
  230.  
  231.         If the request contains a parameter with the name of the
  232.         column + '_usage', it is sniffed for information on how to
  233.         handle applying the index.
  234.  
  235.         Otherwise two objects are returned.  The first object is a
  236.         ResultSet containing the record numbers of the matching
  237.         records.  The second object is a tuple containing the names of
  238.         all data fields used.
  239.  
  240.         """
  241.         id = self.id              #name of the column
  242.  
  243.         cidid = "%s/%s" % (cid,id)
  244.         has_key = request.has_key
  245.         if has_key(cidid): keys = request[cidid]
  246.         elif has_key(id): keys = request[id]
  247.         else: return None
  248.  
  249.         if type(keys) is not ListType: keys=[keys]
  250.         index = self._index
  251.         r = None
  252.         anyTrue = 0
  253.         opr = None
  254.  
  255.         if request.has_key(id+'_usage'):
  256.             # see if any usage params are sent to field
  257.             opr=string.split(string.lower(request[id+"_usage"]),':')
  258.             opr, opr_args=opr[0], opr[1:]
  259.  
  260.         if opr=="range":
  261.             if 'min' in opr_args: lo = min(keys)
  262.             else: lo = None
  263.             if 'max' in opr_args: hi = max(keys)
  264.             else: hi = None
  265.  
  266.             anyTrue=1
  267.             try:
  268.                 if hi:
  269.                     setlist = index.items(lo,hi)
  270.                 else:
  271.                     setlist = index.items(lo)
  272.  
  273.                 for k, set in setlist:
  274.                     if r is None:
  275.                         r = set
  276.                     else:
  277.                         r = r.union(set)
  278.  
  279.             except KeyError:
  280.                 pass
  281.  
  282.         else:           #not a range
  283.             get = index.get
  284.             for key in keys:
  285.                 if key:
  286.                     anyTrue = 1
  287.                 set=get(key)
  288.                 if set is not None:
  289.                     if r is None:
  290.                         r = set
  291.                     else:
  292.                         r = r.union(set)
  293.  
  294.         if r is None:
  295.             if anyTrue:
  296.                 r=intSet()
  297.             else:
  298.                 return None
  299.  
  300.         return r, (id,)
  301.  
  302.  
  303.     def hasUniqueValuesFor(self, name):
  304.         ' has unique values for column NAME '
  305.         if name == self.id:
  306.             return 1
  307.         else:
  308.             return 0
  309.  
  310.  
  311.     def uniqueValues(self, name=None, withLengths=0):
  312.         """\
  313.         returns the unique values for name
  314.  
  315.         if withLengths is true, returns a sequence of
  316.         tuples of (value, length)
  317.         """
  318.         if name is None:
  319.             name = self.id
  320.         elif name != self.id:
  321.             return []
  322.         if not withLengths: return tuple(
  323.             filter(nonEmpty,self._index.keys())
  324.             )
  325.         else: 
  326.             rl=[]
  327.             for i in self._index.keys():
  328.                 if not nonEmpty(i): continue
  329.                 else: rl.append((i, len(self._index[i])))
  330.             return tuple(rl)
  331.  
  332.  
  333.     def clear(self):
  334.         self._index = BTree.BTree()
  335.         self._unindex = IOBTree.BTree()
  336.  
  337.  
  338.  
  339.